Come utilizzare e configurare l'API Client LWS ?

Procédure

L'API Client LWS è un gateway progettato per facilitare l'integrazione con i servizi e i prodotti offerti da LWS (Ligne Web Services). Questa API consente agli utenti di ordinare e gestire in modo efficiente i propri servizi, come l'acquisto di hosting, la modifica dei DNS e molto altro.

In questa documentazione, vi guideremo attraverso i passaggi necessari per ottenere la vostra chiave API e iniziare a utilizzare le funzionalità dell'API Client. [PERSON_NAME] più orientato agli sviluppatori, anche un [PERSON_NAME] può utilizzarlo.

Autenticarsi all'API

Generare la chiave API

Per impedire un accesso abusivo all'API, dovrete ottenere una chiave API collegata al vostro account LWS e definire una o più IP autorizzate a utilizzare l'API. È obbligatorio possedere un account LWS per utilizzare l'API. Se non è il vostro caso, andate sul sito ufficiale LWS per iscrivervi come nuovo cliente.

Per ottenere la vostra chiave API, accedete al vostro account dal LWS Panel e andate alla pagina "Api LWS" cliccando sul vostro numero LWS (LWS-XXXXXX) in alto a destra.

Su questa pagina, potrete vedere tutte le IP autorizzate a utilizzare l'API con i vostri identificativi, così come il saldo del vostro conto prepagato, che potrà essere utilizzato per acquistare o rinnovare i vostri domini e hosting acquistati tramite l'API. Per generare la vostra chiave API, cliccate sul pulsante "voir" di fronte all'opzione "Clé API en mode PRODUCTION" per aprire una modale che consente di generarla.

Qui, cliccate sul pulsante per generare la chiave. Conservatela con cura per non perderla. [PERSON_NAME], tornate su questa modale e cliccate di nuovo sul pulsante.

Questa chiave consente di utilizzare l'API completa nella sua modalità normale. Se desiderate utilizzare l'API in un ambiente isolato, per testarla, dovrete usare una chiave in modalità TEST, che potete creare allo stesso modo di quelle in Produzione, semplicemente cliccando su "voir" di fronte alla riga "Clé API en mode TEST". Non è possibile utilizzare la chiave test in produzione e viceversa.

[PERSON_NAME]>

[ADDRESS] poter utilizzare l'API LWS è autorizzare una o più IP a utilizzare l'API. Si tratta di un metodo di protezione aggiuntivo, affinché una persona che sia riuscita a mettere le mani sulla vostra chiave non possa effettuare ordini indesiderati, come acquistare domini al posto vostro.

[PERSON_NAME] passa nello stesso punto della chiave API; questa volta, cliccate sul pulsante "Ajouter une adresse IP" per aprire la finestra di aggiunta IP.

In questa finestra, selezionate "Production" e inserite il vostro indirizzo IP. [PERSON_NAME], potete utilizzare un sito per ottenere il vostro IP attuale. A seconda della rete a cui siete connessi, il vostro IP potrebbe essere diverso, quindi potrebbe essere necessario indicare più IP per utilizzare l'API ovunque. Se volete aggiungere l'IP per utilizzarlo in modalità Test, selezionate invece "Test".

Una volta convalidato, potrete consultare ed eliminare le IP attualmente autorizzate a utilizzare l'API in una tabella sulla pagina. È possibile aggiungere fino a 3 IP per ogni modalità. Se desiderate aggiungerne altre, dovrete eliminarne alcune.

Utilizzare l'API Client LWS

Potete trovare la documentazione ufficiale, con l'elenco di tutti i comandi disponibili e degli esempi d'uso per scoprire come utilizzare la nostra API.

Selezionate una categoria e un comando nel menu a sinistra per ottenere maggiori informazioni su di essi. Ogni pagina è composta da più parti; la parte superiore della pagina contiene un riepilogo dell'azione e l'URL da utilizzare per questo comando:

Nel caso in cui il comando richieda un parametro aggiuntivo, sarà indicato sotto, [ADDRESS] parte "Request". Nel caso del nostro esempio, [ADDRESS] attende un nome di dominio nel "PATH", l'URL del comando (al posto di :domain) :

Nel caso in cui siano necessari altri parametri, in particolare nel corpo della richiesta, saranno anch'essi indicati [ADDRESS] categorìa "body".

Tutti i comandi restituiranno un messaggio una volta eseguiti. [PERSON_NAME] può essere un messaggio di errore, di conferma oppure i dati richiesti (nel nostro esempio, le informazioni sul dominio). Potete trovare tutte le risposte possibili di un comando specifico nella sezione "Responses" della pagina :

Per un [PERSON_NAME], queste informazioni sono tutto ciò di cui avrà bisogno per utilizzare comodamente l'API. Tuttavia, nell'ottica di proporre l'API al maggior numero possibile di persone, [PERSON_NAME] siano principianti o esperte, sono disponibili esempi d'uso in diversi linguaggi di programmazione, come il PHP :

Qui si tratta di un esempio di comando cURL da eseguire nel Terminale. I campi X-Auth-Login e X-Auth-Path devono essere compilati rispettivamente con il vostro ID LWS e la vostra chiave API, ottenuta in precedenza.

Il campo X-Test-Mode è facoltativo e può essere rimosso se inutile. Permette, se impostato su "true", di avviare il comando in un ambiente di test senza effettuare azioni sul vostro account. [PERSON_NAME] come funziona l'API senza però eseguire manipolazioni sul vostro account. Dovrete inserire una API Test nel campo X-Auth-Pass se scegliete di utilizzare la modalità test.

[PERSON_NAME], vi è possibile utilizzare l'API direttamente dalla documentazione :

Per farlo, inserite rispettivamente il vostro ID LWS e la vostra chiave API nei campi ApiAuthID e ApiPasswordKey, così come tutti i parametri richiesti dal comando, quindi cliccate su "SEND API REQUEST". [PERSON_NAME] test, inserite "true" nel campo TestMode.

Otterrete quindi sotto il risultato del comando eseguito :

Comandi a pagamento

[PERSON_NAME], alcuni comandi dell'API non potranno funzionare senza credito prepagato sull'account. L'acquisto di un dominio, il rinnovo di un hosting, il cambio di una formula, ... Ogni volta che l'azione richiede un pagamento, vi verrà addebitato l'importo corrispondente sul vostro credito prepagato LWS (solo in caso di successo dell'azione). Non è possibile tornare indietro una volta effettuato il comando. Assicuratevi di sapere cosa state facendo prima di utilizzare i comandi a pagamento.

Il conto prepagato è attualmente l'unico metodo di pagamento accettato dall'API. [PERSON_NAME] non ci sono fondi sufficienti sul vostro account, potete ricaricarlo sulla pagina dedicata.

Conclusione

Ora sapete come:

• Ottenere la vostra chiave API e configurare le IP autorizzate per proteggere l'accesso all'API Client LWS.
• Utilizzare l'API per gestire i vostri servizi presso LWS, incluso l'acquisto di hosting, la modifica dei DNS e molto altro.
• Esplorare la documentazione ufficiale per scoprire tutti i comandi disponibili e le loro specificità.
• Eseguire esempi di utilizzo dell'API in diversi linguaggi di programmazione, come il PHP.
• Utilizzare l'API in modalità test per sperimentare senza impattare [PERSON_NAME]>
• [PERSON_NAME] a pagamento e richiedono un saldo prepagato sufficiente sul vostro account.

Grazie a queste informazioni, [PERSON_NAME]>API Client LWS per una gestione ottimale dei vostri servizi online. 🚀💻

Grazie per averci letto! [PERSON_NAME] avete domande o desiderate condividere la vostra esperienza con l'API Client LWS, non esitate a lasciare un commento. Il vostro feedback è prezioso per noi e per la community. [PERSON_NAME]📢